datocms-structured-text-utils

What is datocms-structured-text-utils?

The datocms-structured-text-utils package provides utilities for working with DatoCMS's structured text format. It allows developers to parse, manipulate, and render structured text content in a flexible and efficient manner.

What are datocms-structured-text-utils's main functionalities?

Rendering Structured Text

This feature allows you to render structured text documents into HTML. The code sample demonstrates how to convert a simple structured text document into an HTML paragraph.

const { render } = require('datocms-structured-text-utils');

const document = {
  schema: 'dast',
  document: {
    type: 'root',
    children: [
      {
        type: 'paragraph',
        children: [{ type: 'span', value: 'Hello, world!' }]
      }
    ]
  }
};

const html = render(document);
console.log(html); // Outputs: <p>Hello, world!</p>

Transforming Structured Text

This feature allows you to transform structured text documents. The code sample shows how to transform the text content of a paragraph to uppercase.

const { transform } = require('datocms-structured-text-utils');

const document = {
  schema: 'dast',
  document: {
    type: 'root',
    children: [
      {
        type: 'paragraph',
        children: [{ type: 'span', value: 'Hello, world!' }]
      }
    ]
  }
};

const transformedDocument = transform(document, {
  paragraph: ({ children }) => ({
    type: 'paragraph',
    children: [{ type: 'span', value: children[0].value.toUpperCase() }]
  })
});

console.log(transformedDocument);

Other packages similar to datocms-structured-text-utils

slate

Slate is a completely customizable framework for building rich text editors. It provides a more general-purpose solution for handling rich text, whereas datocms-structured-text-utils is specifically tailored for DatoCMS's structured text format.

draft-js

Draft.js is a framework for building rich text editors in React. It offers a comprehensive set of tools for managing editor state and rendering, similar to datocms-structured-text-utils, but is more focused on providing a complete editor experience.

prosemirror

ProseMirror is a toolkit for building rich text editors with a focus on extensibility and customizability. Like datocms-structured-text-utils, it allows for manipulation and rendering of text content, but it is more focused on providing a full editor framework.

README

datocms-structured-text-utils

TODO: description

Usage

const datocmsStructuredTextUtils = require('datocms-structured-text-utils');

// TODO: DEMONSTRATE API